Class RouterPortImpl

All Implemented Interfaces:
IPCObject, HostPort, Port, Process, RouterPort
Direct Known Subclasses:
FRSubInterfaceImpl, RoutedSwitchPortImpl, VirtualTemplateInterfaceImpl

public class RouterPortImpl extends HostPortImpl implements RouterPort
Information provided by the PKI file:

    \class RouterPort
    
    \brief RouterPort handles and manipulates the router port.
    
    \example network().getDevice("Router0").getPort("FastEthernet0/0")
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • setAclInID

      public void setAclInID(String aclId)
      Information provided by the PKI file:
      
          \brief Sets an inbound ACL.
          
          \param aclId, the ID of the ACL.
          
              
      Specified by:
      setAclInID in interface RouterPort
      Parameters:
      aclId - Takes in a parameter of aclId
    • setAclOutID

      public void setAclOutID(String aclId)
      Information provided by the PKI file:
      
          \brief Sets an outbound ACL.
          
          \param aclId, the ID of the ACL.
          
              
      Specified by:
      setAclOutID in interface RouterPort
      Parameters:
      aclId - Takes in a parameter of aclId
    • getAclInID

      public String getAclInID()
      Information provided by the PKI file:
      
          \brief Returns the inbound ACL ID.
          
          \param string, the ID of the inbound ACL.
          
              
      Specified by:
      getAclInID in interface RouterPort
      Returns:
      String Returns a String
    • getAclOutID

      public String getAclOutID()
      Information provided by the PKI file:
      
          \brief Returns the outbound ACL ID.
          
          \param string, the ID of the outbound ACL.
          
              
      Specified by:
      getAclOutID in interface RouterPort
      Returns:
      String Returns a String
    • setNatMode

      public void setNatMode(NATMode type)
      Information provided by the PKI file:
      
          \brief Sets the NAT mode.
          
          \param type,        the NAT mode.
          NAT modes:  eNatNull = 0,
          eNatInside = 1,
          eNatOutside = 2
          
              
      Specified by:
      setNatMode in interface RouterPort
      Parameters:
      type - Takes in a parameter of type
    • getNatMode

      public NATMode getNatMode()
      Information provided by the PKI file:
      
          \brief Returns the NAT mode.
          
          \param NatMode,     the NAT mode.
          NAT modes:  eNatNull = 0,
          eNatInside = 1,
          eNatOutside = 2
          
              
      Specified by:
      getNatMode in interface RouterPort
      Returns:
      NATMode Returns a NATMode
    • setCdpEnable

      public void setCdpEnable(boolean bEnable)
      Information provided by the PKI file:
      
          \brief Enables or disables CDP.
          
          \param bEnable, true to enable CDP, false to disable it.
          
              
      Specified by:
      setCdpEnable in interface RouterPort
      Parameters:
      bEnable - Takes in a parameter of bEnable
    • isCdpEnable

      public boolean isCdpEnable()
      Information provided by the PKI file:
      
          \brief Returns true if CDP is enabled, otherwise false.
          
          \return bool, true if CDP is enabled, otherwise false.
          
              
      Specified by:
      isCdpEnable in interface RouterPort
      Returns:
      boolean Returns a boolean
    • setRipPassive

      public void setRipPassive(boolean bRipPassive)
      Information provided by the PKI file:
      
          \brief Enables or disables RIP passive interface.
          
          \param bRipPassive, true to enable RIP passive interface, false to disable it.
          
              
      Specified by:
      setRipPassive in interface RouterPort
      Parameters:
      bRipPassive - Takes in a parameter of bRipPassive
    • isRipPassive

      public boolean isRipPassive()
      Information provided by the PKI file:
      
          \brief Returns true if RIP passive interface is enabled, otherwise false.
          
          \return bool, true if RIP passive interface is enabled, otherwise false.
          
              
      Specified by:
      isRipPassive in interface RouterPort
      Returns:
      boolean Returns a boolean
    • setRipSplitHorizon

      public void setRipSplitHorizon(boolean bEnable)
      Information provided by the PKI file:
      
          \brief Enables or disables RIP split horizon.
          
          \param bEnable, true to enable RIP split horizon, false to disable it.
          
              
      Specified by:
      setRipSplitHorizon in interface RouterPort
      Parameters:
      bEnable - Takes in a parameter of bEnable
    • isRipSplitHorizon

      public boolean isRipSplitHorizon()
      Information provided by the PKI file:
      
          \brief Returns true if RIP split horizon is enabled, otherwise false.
          
          \return bool, true if RIP split horizon is enabled, otherwise false.
          
              
      Specified by:
      isRipSplitHorizon in interface RouterPort
      Returns:
      boolean Returns a boolean
    • addEntryEigrpPassive

      public void addEntryEigrpPassive(int as, boolean bPassive)
      Information provided by the PKI file:
      
          \brief Enables or disables EIGRP passive interface for the specified AS.
          
          \param as, the EIGRP AS number.
          \param bPassive, true to enable EIGRP passive interface, false to disable it.
          
              
      Specified by:
      addEntryEigrpPassive in interface RouterPort
      Parameters:
      as - Takes in a parameter of as
      bPassive - Takes in a parameter of bPassive
    • removeEntryEigrpPassive

      public void removeEntryEigrpPassive(int as)
      Information provided by the PKI file:
      
          \brief Remvoes EIGRP passive interface for the specified AS.
          
          \param as, the EIGRP AS number of interest.
          
              
      Specified by:
      removeEntryEigrpPassive in interface RouterPort
      Parameters:
      as - Takes in a parameter of as
    • getOspfAuthType

      public int getOspfAuthType()
      Information provided by the PKI file:
      
          \brief Returns the OSPF authentication type.
          
          \return int, the OSPF authentication type.
          
              
      Specified by:
      getOspfAuthType in interface RouterPort
      Returns:
      int Returns a int
    • setOspfAuthKey

      public void setOspfAuthKey(String key)
      Information provided by the PKI file:
      
          \brief Sets the OSPF authentication key.
          
          \param key, the OSPF authentication key.
          
              
      Specified by:
      setOspfAuthKey in interface RouterPort
      Parameters:
      key - Takes in a parameter of key
    • getOspfAuthKey

      public String getOspfAuthKey()
      Information provided by the PKI file:
      
          \brief Returns the OSPF authentication key.
          
          \param string, the OSPF authentication key.
          
              
      Specified by:
      getOspfAuthKey in interface RouterPort
      Returns:
      String Returns a String
    • addOspfMd5Key

      public boolean addOspfMd5Key(Short keyId, String key)
      Information provided by the PKI file:
      
          \brief Adds an OSPF MD5 key.
          
          \param keyId, the key ID.
          \param key, the key.
          
          \return bool, true if successful, otherwise false.
          
              
      Specified by:
      addOspfMd5Key in interface RouterPort
      Parameters:
      keyId - Takes in a parameter of keyId
      key - Takes in a parameter of key
      Returns:
      boolean Returns a boolean
    • removeOspfMd5Key

      public void removeOspfMd5Key(Short keyId)
      Information provided by the PKI file:
      
          \brief Removes the specified OSPF MD5 key.
          
          \param keyId, the key ID.
          
              
      Specified by:
      removeOspfMd5Key in interface RouterPort
      Parameters:
      keyId - Takes in a parameter of keyId
    • setOspfCost

      public void setOspfCost(Short cost)
      Information provided by the PKI file:
      
          \brief Sets the OSPF cost.
          
          \param cost, the cost value.
          
              
      Specified by:
      setOspfCost in interface RouterPort
      Parameters:
      cost - Takes in a parameter of cost
    • getOspfCost

      public Short getOspfCost()
      Information provided by the PKI file:
      
          \brief Returns the OSPF cost.
          
          \return short, the cost value.
          
              
      Specified by:
      getOspfCost in interface RouterPort
      Returns:
      Short Returns a Short
    • setOspfDeadInterval

      public void setOspfDeadInterval(Short interval)
      Information provided by the PKI file:
      
          \brief Sets the OSPF dead interval.
          
          \param interval, the OSPF dead interval value.
          
              
      Specified by:
      setOspfDeadInterval in interface RouterPort
      Parameters:
      interval - Takes in a parameter of interval
    • getOspfDeadInterval

      public Short getOspfDeadInterval()
      Information provided by the PKI file:
      
          \brief Returns the OSPF dead interval.
          
          \return short, the OSPF dead interval value.
          
              
      Specified by:
      getOspfDeadInterval in interface RouterPort
      Returns:
      Short Returns a Short
    • setOspfHelloInterval

      public void setOspfHelloInterval(Short interval)
      Information provided by the PKI file:
      
          \brief Sets the OSPF hello interval.
          
          \param interval, the OSPF hello interval value.
          
              
      Specified by:
      setOspfHelloInterval in interface RouterPort
      Parameters:
      interval - Takes in a parameter of interval
    • getOspfHelloInterval

      public Short getOspfHelloInterval()
      Information provided by the PKI file:
      
          \brief Returns the OSPF hello interval.
          
          \return short, the OSPF hello interval value.
          
              
      Specified by:
      getOspfHelloInterval in interface RouterPort
      Returns:
      Short Returns a Short
    • setOspfPriority

      public void setOspfPriority(Short usPriority)
      Information provided by the PKI file:
      
          \brief Sets the OSPF priority.
          
          \param usPriority, the OSPF priority value.
          
              
      Specified by:
      setOspfPriority in interface RouterPort
      Parameters:
      usPriority - Takes in a parameter of usPriority
    • getOspfPriority

      public Short getOspfPriority()
      Information provided by the PKI file:
      
          \brief Returns the OSPF priority.
          
          \return short, the OSPF priority value.
          
              
      Specified by:
      getOspfPriority in interface RouterPort
      Returns:
      Short Returns a Short
    • setDelay

      public void setDelay(int delay)
      Information provided by the PKI file:
      
          \brief Sets the delay.
          
          \param delay, the delay value.
          
              
      Specified by:
      setDelay in interface RouterPort
      Parameters:
      delay - Takes in a parameter of delay
    • getDelay

      public int getDelay()
      Information provided by the PKI file:
      
          \brief Returns the delay.
          
          \return delay, the delay value.
          
              
      Specified by:
      getDelay in interface RouterPort
      Returns:
      int Returns a int
    • setBandwidthInfo

      public void setBandwidthInfo(int bandwidth)
      Information provided by the PKI file:
      
          \brief Sets the bandwidth.
          
          \param bandwidth, the bandwidth value.
          
              
      Specified by:
      setBandwidthInfo in interface RouterPort
      Parameters:
      bandwidth - Takes in a parameter of bandwidth
    • getBandwidthInfo

      public int getBandwidthInfo()
      Information provided by the PKI file:
      
          \brief Returns the bandwidth.
          
          \return int, the bandwidth value.
          
              
      Specified by:
      getBandwidthInfo in interface RouterPort
      Returns:
      int Returns a int
    • resetBandwidth

      public void resetBandwidth()
      Information provided by the PKI file:
      
          \brief Resets the bandwidth.
          
              
      Specified by:
      resetBandwidth in interface RouterPort
    • resetDelay

      public void resetDelay()
      Information provided by the PKI file:
      
          \brief Resets the delay.
          
              
      Specified by:
      resetDelay in interface RouterPort
    • setIntForAs

      public void setIntForAs(Short as, Short interval)
      Information provided by the PKI file:
      
          \brief Sets the interval for the specified EIGRP AS.
          
          \param as, the EIGRP AS of interest.
          \param interval, the interval value.
          
              
      Specified by:
      setIntForAs in interface RouterPort
      Parameters:
      as - Takes in a parameter of as
      interval - Takes in a parameter of interval
    • getIntOfAs

      public Short getIntOfAs(Short as)
      Information provided by the PKI file:
      
          \brief Returns the interval for the specified EIGRP AS.
          
          \param as, the EIGRP AS of interest.
          
          \return short, the interval for the specified EIGRP AS.
          
              
      Specified by:
      getIntOfAs in interface RouterPort
      Parameters:
      as - Takes in a parameter of as
      Returns:
      Short Returns a Short
    • addSummaryAddress

      public boolean addSummaryAddress(Short as, IPAddress networkAddress, IPAddress mask, int adminDistance)
      Information provided by the PKI file:
      
          \brief Adds a summary address for the specified EIGRP AS.
          
          \param as, the EIGRP AS of interest.
          \param networkAddress, the network address.
          \param mask, the network mask.
          \param adminDistance, the administrative distance value.
          
          \return bool, true if successful, otherwise false.
          
              
      Specified by:
      addSummaryAddress in interface RouterPort
      Parameters:
      as - Takes in a parameter of as
      networkAddress - Takes in a parameter of networkAddress
      mask - Takes in a parameter of mask
      adminDistance - Takes in a parameter of adminDistance
      Returns:
      boolean Returns a boolean
    • removeSummaryAddress

      public boolean removeSummaryAddress(Short as, IPAddress networkAddress, IPAddress mask, int adminDistance)
      Information provided by the PKI file:
      
          \brief Removes the summary address for the specified EIGRP AS.
          
          \param as, the EIGRP AS of interest.
          \param networkAddress, the network address.
          \param mask, the network mask.
          \param adminDistance, the administrative distance value.
          
          \return bool, true if successful, otherwise false.
          
              
      Specified by:
      removeSummaryAddress in interface RouterPort
      Parameters:
      as - Takes in a parameter of as
      networkAddress - Takes in a parameter of networkAddress
      mask - Takes in a parameter of mask
      adminDistance - Takes in a parameter of adminDistance
      Returns:
      boolean Returns a boolean
    • getZoneMemberName

      public String getZoneMemberName()
      Information provided by the PKI file:
      
          \brief Returns the zone name in which this port belongs.
          
          \return string, the zone name in which this port belongs.
          
              
      Specified by:
      getZoneMemberName in interface RouterPort
      Returns:
      String Returns a String
    • setZoneMemberName

      public void setZoneMemberName(String name)
      Information provided by the PKI file:
      
          \brief Sets the zone name for this port.
          
          \param name, the zone name for this port.
          
              
      Specified by:
      setZoneMemberName in interface RouterPort
      Parameters:
      name - Takes in a parameter of name
    • setIpsInID

      public void setIpsInID(String name)
      Information provided by the PKI file:
      
          \brief Sets the IPS as inside ID for this port.
          
          \param name, the name of the IPS.
          
              
      Specified by:
      setIpsInID in interface RouterPort
      Parameters:
      name - Takes in a parameter of name
    • setIpsOutID

      public void setIpsOutID(String name)
      Information provided by the PKI file:
      
          \brief Sets the IPS as outside ID for this port.
          
          \param name, the name of the IPS.
          
              
      Specified by:
      setIpsOutID in interface RouterPort
      Parameters:
      name - Takes in a parameter of name
    • getIpsInID

      public String getIpsInID()
      Information provided by the PKI file:
      
          \brief Returns the IPS inside ID.
          
          \return string, the name of the IPS.
          
              
      Specified by:
      getIpsInID in interface RouterPort
      Returns:
      String Returns a String
    • getIpsOutID

      public String getIpsOutID()
      Information provided by the PKI file:
      
          \brief Returns the ips outside ID.
          
          \return string, the name of the IPS.
          
              
      Specified by:
      getIpsOutID in interface RouterPort
      Returns:
      String Returns a String
    • setProxyArpEnabled

      public void setProxyArpEnabled(boolean enabled)
      Information provided by the PKI file:
      
          \brief Enables or disables proxy ARP.
          
          \param enabled, true to enable proxy ARP, false to disable it.
          
              
      Specified by:
      setProxyArpEnabled in interface RouterPort
      Parameters:
      enabled - Takes in a parameter of enabled
    • isProxyArpEnabled

      public boolean isProxyArpEnabled()
      Information provided by the PKI file:
      
          \brief Returns true if proxy ARP is enabled, otherwise false.
          
          \return bool, true if proxy ARP is enabled, otherwise false.
          
              
      Specified by:
      isProxyArpEnabled in interface RouterPort
      Returns:
      boolean Returns a boolean
    • isIkeEnabled

      public boolean isIkeEnabled()
      Information provided by the PKI file:
      
          \brief Check is Ike is enabled on the port
          
          \return bool, true if it is enabled and false otherwise.
          
              
      Specified by:
      isIkeEnabled in interface RouterPort
      Returns:
      boolean Returns a boolean
    • setIkeEnabled

      public void setIkeEnabled(boolean flag)
      Information provided by the PKI file:
      
          \brief Enable or disable Ike on the port
          
          \param flag, true to enable and false otherwise.
          
              
      Specified by:
      setIkeEnabled in interface RouterPort
      Parameters:
      flag - Takes in a parameter of flag